/*
 * Alloy Analyzer
 * Copyright (c) 2002 Massachusetts Institute of Technology
 *
 * The Alloy Analyzer is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free oftware Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The Alloy Analyzer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the Alloy Analyzer; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

/*
 * Created on Jun 29, 2005 by rseater
 */
package alloy.util;

import java.util.Iterator;

import org.apache.commons.collections.Bag;

/**
 * I wish I was using Ruby so I could add this function to Bag
 * 
 * @author rseater
 */
public class UsefulBagFunctions {

	/**
	 * @param b a bag to be examined
	 * @return the frequency of the most frequent element
	 */
	static public int highestCount (Bag b) {
		int runningCount = 0;
		for(Iterator i = b.uniqueSet().iterator() ; i.hasNext() ; ) {
			final Object current = i.next();
			final int currentCount = b.getCount(current);
			runningCount = Math.max(runningCount, currentCount);
		}
		return runningCount;
	}
	
}
